IApi.EnableAutoRepair method

Allows auto-repair to be enabled. If any slave disappears (due to the replacement of a servo drive, cable disconnection, power cut or other issues) or goes to an EtherCAT error state, it restarts automatically. Slaves that are not in an error state are not impacted and continue to function properly.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError EnableAutoRepair(
       bool Active
)

Function EnableAutoRepair(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true to enable, and false to disable auto-repair. By default, it is true.

Return value

Type: KsError

A return code of a method.

Remarks

This method must be called after Create or CreateAsync and before Start.
For more information about how HotConnect, AutoRepair, and AutoRestart work, see Concepts > HotConnect, Repair, and Restart.

Usable EtherCAT states

ecatOffline

Examples

N/A